
<!DOCTYPE html>

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta charset="utf-8" />
    <title>Overview of Dispersed Phases Module &#8212; Texas A&amp;M Oil spill / Outfall Calculator 2.1.0 documentation</title>
    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
    <script src="../_static/jquery.js"></script>
    <script src="../_static/underscore.js"></script>
    <script src="../_static/doctools.js"></script>
    <script src="../_static/language_data.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="dispersed_phases.SingleParticle" href="../autodoc/disp_phases/dispersed_phases.SingleParticle.html" />
    <link rel="prev" title="dbm_utilities.print_petroleum_props" href="../autodoc/dbm_utilities/dbm_utilities.print_petroleum_props.html" />
   
  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <div class="section" id="overview-of-dispersed-phases-module">
<h1>Overview of Dispersed Phases Module<a class="headerlink" href="#overview-of-dispersed-phases-module" title="Permalink to this headline">¶</a></h1>
<dl class="field-list simple">
<dt class="field-odd">Release</dt>
<dd class="field-odd"><p>2.1</p>
</dd>
<dt class="field-even">Date</dt>
<dd class="field-even"><p>Jun 05, 2020</p>
</dd>
</dl>
<span class="target" id="module-dispersed_phases"></span><div class="section" id="dispersed-phases">
<h2>Dispersed Phases<a class="headerlink" href="#dispersed-phases" title="Permalink to this headline">¶</a></h2>
<p>Create several objects and functions to manipulate dispersed phase particles</p>
<p>The <cite>single_bubble_model</cite>, <cite>stratified_plume_model</cite>, and <cite>bent_plume_model</cite> 
all must handle dispersed phase particles in several different ways.  This 
module defines several particle classes that provide seamless interfaces to
the <cite>dbm</cite> module.  It also defines several functions that aid in manipulating
common input data to create the inputs needed to initialize these particle
classes.  These classes and functions originated in the older versions of
the <cite>single_bubble_model</cite> and <cite>stratified_plume_model</cite>.  This module is a 
re-factorization of these modules during creation of the <cite>bent_plume_model</cite>, 
which allows all particle manipulations to reside in one place.</p>
<div class="section" id="notes">
<h3>Notes<a class="headerlink" href="#notes" title="Permalink to this headline">¶</a></h3>
<p>These class objects and helper functions are used throughout the TAMOC 
modeling suite.</p>
</div>
<div class="section" id="see-also">
<h3>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h3>
<dl class="simple">
<dt><cite>stratified_plume_model</cite><span class="classifier">Predicts the plume solution for quiescent ambient</span></dt><dd><p>conditions or weak crossflows, where the intrusion (outer plume) 
interacts with the upward rising plume in a double-plume integral model
approach.  Such a situation is handeled properly in the 
<cite>stratified_plume_model</cite> and would violate the assumption of non-
iteracting Lagrangian plume elements as required in this module.</p>
</dd>
<dt><cite>single_bubble_model</cite><span class="classifier">Tracks the trajectory of a single bubble, drop or </span></dt><dd><p>particle through the water column.  The numerical solution, including
the various object types and their functionality, used here follows the
pattern in the <cite>single_bubble_model</cite>.  The main difference is the more
complex state space and governing equations.</p>
</dd>
<dt><cite>bent_plume_model</cite><span class="classifier">Simulates a multiphase plume as a Lagrangian plume </span></dt><dd><p>model, which makes the model much more amenable to a crossflow.  This 
model is similar to the <cite>stratified_plume_model</cite>, except that it does
not have an outer plume that interacts with the inner plume (Lagrangian
elements are independent).</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="class-objects-and-methods">
<h2>Class Objects and Methods<a class="headerlink" href="#class-objects-and-methods" title="Permalink to this headline">¶</a></h2>
<div class="section" id="general-particle-object">
<h3>General Particle Object<a class="headerlink" href="#general-particle-object" title="Permalink to this headline">¶</a></h3>
<p>Several modules in <code class="docutils literal notranslate"><span class="pre">TAMOC</span></code> need <code class="docutils literal notranslate"><span class="pre">Particle</span></code> objects, and the functionality
of these objects can often be described in a unified way.  The base <code class="docutils literal notranslate"><span class="pre">SingleParticle</span></code> object contains this functionality and is described in
the following:</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.SingleParticle.html#dispersed_phases.SingleParticle" title="dispersed_phases.SingleParticle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SingleParticle</span></code></a>(dbm_particle, m0, T0[, K, …])</p></td>
<td><p>Interface to the <cite>dbm</cite> module and container for model parameters</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.SingleParticle.properties.html#dispersed_phases.SingleParticle.properties" title="dispersed_phases.SingleParticle.properties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SingleParticle.properties</span></code></a>(self, m, T, P, Sa, …)</p></td>
<td><p>Return the particle properties from the discrete bubble model</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.SingleParticle.diameter.html#dispersed_phases.SingleParticle.diameter" title="dispersed_phases.SingleParticle.diameter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SingleParticle.diameter</span></code></a>(self, m, T, P, Sa, Ta)</p></td>
<td><p>Compute the diameter of a particle from mass and density</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.SingleParticle.biodegradation_rate.html#dispersed_phases.SingleParticle.biodegradation_rate" title="dispersed_phases.SingleParticle.biodegradation_rate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">SingleParticle.biodegradation_rate</span></code></a>(self, t)</p></td>
<td><p>Compute the biodegradation rate constants</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="plume-particle-object">
<h3>Plume Particle Object<a class="headerlink" href="#plume-particle-object" title="Permalink to this headline">¶</a></h3>
<p>When a <code class="docutils literal notranslate"><span class="pre">SingleParticle</span></code> is inside of a plume (e.g., a <code class="docutils literal notranslate"><span class="pre">stratified_plume_model</span></code> or <code class="docutils literal notranslate"><span class="pre">bent_plume_model</span></code>), it needs slightly
different capabilities.  These are provided as follows in the <code class="docutils literal notranslate"><span class="pre">PlumeParticle</span></code> object, which inherits the base object above:</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.PlumeParticle.html#dispersed_phases.PlumeParticle" title="dispersed_phases.PlumeParticle"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlumeParticle</span></code></a>(dbm_particle, m0, T0, nb0, …)</p></td>
<td><p>Interface to the <cite>dbm</cite> module and container for the model parameters</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.PlumeParticle.properties.html#dispersed_phases.PlumeParticle.properties" title="dispersed_phases.PlumeParticle.properties"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlumeParticle.properties</span></code></a>(self, m, T, P, Sa, …)</p></td>
<td><p>Return the particle properties from the discrete bubble model</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.PlumeParticle.diameter.html#dispersed_phases.PlumeParticle.diameter" title="dispersed_phases.PlumeParticle.diameter"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlumeParticle.diameter</span></code></a>(self, m, T, P, Sa, Ta)</p></td>
<td><p>Compute the diameter of a particle from mass and density</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.PlumeParticle.biodegradation_rate.html#dispersed_phases.PlumeParticle.biodegradation_rate" title="dispersed_phases.PlumeParticle.biodegradation_rate"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlumeParticle.biodegradation_rate</span></code></a>(self, t)</p></td>
<td><p>Compute the biodegradation rate constants</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.PlumeParticle.update.html#dispersed_phases.PlumeParticle.update" title="dispersed_phases.PlumeParticle.update"><code class="xref py py-obj docutils literal notranslate"><span class="pre">PlumeParticle.update</span></code></a>(self, m, T, P, Sa, Ta, t)</p></td>
<td><p>Store the instantaneous values of the particle properties</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="module-functions">
<h2>Module Functions<a class="headerlink" href="#module-functions" title="Permalink to this headline">¶</a></h2>
<p>This module also contains several utilities to create particle objects and
to user particle objects to create initial conditions for the various plume
models.  These utilities are listed below:</p>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.initial_conditions.html#dispersed_phases.initial_conditions" title="dispersed_phases.initial_conditions"><code class="xref py py-obj docutils literal notranslate"><span class="pre">initial_conditions</span></code></a>(profile, z0, …[, T0])</p></td>
<td><p>Define standard initial conditions for a PlumeParticle from flow rate</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.save_particle_to_nc_file.html#dispersed_phases.save_particle_to_nc_file" title="dispersed_phases.save_particle_to_nc_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">save_particle_to_nc_file</span></code></a>(nc, chem_names, …)</p></td>
<td><p>Write the particle attributes to a netCDF output file</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.load_particle_from_nc_file.html#dispersed_phases.load_particle_from_nc_file" title="dispersed_phases.load_particle_from_nc_file"><code class="xref py py-obj docutils literal notranslate"><span class="pre">load_particle_from_nc_file</span></code></a>(nc)</p></td>
<td><p>Read the complete <cite>particles</cite> list from a netCDF output file</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.shear_entrainment.html#dispersed_phases.shear_entrainment" title="dispersed_phases.shear_entrainment"><code class="xref py py-obj docutils literal notranslate"><span class="pre">shear_entrainment</span></code></a>(U, Us, rho, rho_a, b, sin_p, p)</p></td>
<td><p>Compute the entrainment coefficient for shear entrainment</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.hydrate_formation_time.html#dispersed_phases.hydrate_formation_time" title="dispersed_phases.hydrate_formation_time"><code class="xref py py-obj docutils literal notranslate"><span class="pre">hydrate_formation_time</span></code></a>(dbm_obj, z, m, T, profile)</p></td>
<td><p>Compute the hydrate formation time</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.zfe_volume_flux.html#dispersed_phases.zfe_volume_flux" title="dispersed_phases.zfe_volume_flux"><code class="xref py py-obj docutils literal notranslate"><span class="pre">zfe_volume_flux</span></code></a>(profile, particles, p, X0, R)</p></td>
<td><p>Initial volume for a multiphase plume</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.wuest_ic.html#dispersed_phases.wuest_ic" title="dispersed_phases.wuest_ic"><code class="xref py py-obj docutils literal notranslate"><span class="pre">wuest_ic</span></code></a>(u_0, particles, lambda_1, …)</p></td>
<td><p>Compute the initial velocity of entrained ambient fluid</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.bf_average.html#dispersed_phases.bf_average" title="dispersed_phases.bf_average"><code class="xref py py-obj docutils literal notranslate"><span class="pre">bf_average</span></code></a>(particles, rho, g, rho_r, parm)</p></td>
<td><p>Compute a buoyancy-flux-weighted average of <cite>parm</cite></p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.get_chem_names.html#dispersed_phases.get_chem_names" title="dispersed_phases.get_chem_names"><code class="xref py py-obj docutils literal notranslate"><span class="pre">get_chem_names</span></code></a>(particles)</p></td>
<td><p>Create a list of chemical names for the dispersed phase particles</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="../autodoc/disp_phases/dispersed_phases.particles_state_space.html#dispersed_phases.particles_state_space" title="dispersed_phases.particles_state_space"><code class="xref py py-obj docutils literal notranslate"><span class="pre">particles_state_space</span></code></a>(particles, nb)</p></td>
<td><p>Create the state space describing the dispersed phase properties</p></td>
</tr>
</tbody>
</table>
</div>
</div>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../index.html">Texas A&M Oil spill / Outfall Calculator</a></h1>








<h3>Navigation</h3>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="../user_manual.html">TAMOC User Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="../unit_tests.html">Unit Tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="../glossary.html">Glossary</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../bugs.html">Reporting Bugs</a></li>
<li class="toctree-l1"><a class="reference internal" href="../readme.html">Read Me File</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release.html">Release Notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../license.html">License</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../index.html">Documentation overview</a><ul>
  <li><a href="../user_manual.html">TAMOC User Manual</a><ul>
      <li>Previous: <a href="../autodoc/dbm_utilities/dbm_utilities.print_petroleum_props.html" title="previous chapter">dbm_utilities.print_petroleum_props</a></li>
      <li>Next: <a href="../autodoc/disp_phases/dispersed_phases.SingleParticle.html" title="next chapter">dispersed_phases.SingleParticle</a></li>
  </ul></li>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>








        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2020, Scott A. Socolofsky.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.4.4</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../_sources/modules/disp_phases.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    

    
  </body>
</html>